home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / rescue16.zip / RESCUE.DOC < prev    next >
Text File  |  1992-06-18  |  18KB  |  393 lines

  1.  
  2.                                  Rescue
  3.  
  4.                                   v1.6
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    You have received a call informing you that bombs have been planted in 
  21.    this 100 room hotel. You also determine that there are guests currently
  22.    in their rooms. Your mission is to RESCUE all the guests.
  23.  
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.  
  30.                               INSTALLATION
  31.                               ____________
  32.  
  33.  
  34.    Installation is fairly easy and straight-forward. The following steps and
  35.    examples should have you up and running in a very short period of time.
  36.    It is assumed that you are familiar with setting up DOORS on your system.
  37.    To this end, only examples of the configuration file and Door batch file
  38.    are described.
  39.  
  40.       1) Create a directory to hold all RESCUE files
  41.  
  42.       2) Unzip RESCUExx.ZIP into the the above directory
  43.  
  44.          NOTE: BRUN45.EXE is not included but is required !!!
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied RESCUE.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First nameAP
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.     !   #   1                        Maximum # of Games per day
  63.                                      (Sysop gets 99, Registered version ONLY)
  64.  
  65.         #   50                       Number of Top Score Entries
  66.  
  67.         #   NONE                     Drive:\Path\Filename to contain the
  68.                                      Top Score Bulletin or enter NONE
  69.                                      for NO Bulletin creation.
  70.  
  71.         #   NONE                     Drive:\Path\Filename to contain the
  72.                                      Top Score Bulletin (Color) or enter NONE
  73.                                      for NO Bulletin creation.
  74.  
  75.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  76.                                      2 = Display ADOPT-A-DOOR message
  77.  
  78.         #   2                        Keyboard timeout value in Minutes
  79.  
  80.     !   #   0                        Time Allowed in Door
  81.                                      (Sysop = Time Remaining - REG. VERSION)
  82.  
  83.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  84.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  85.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  86.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  87.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.          
  94.     @   #   XXXX/YYYY                 Blackout Range  From/To
  95.     @   #   XXXX/YYYY                 Blackout Range  From/To
  96.     @   #   XXXX/YYYY                 Blackout Range  From/To
  97.     @   #   XXXX/YYYY                 Blackout Range  From/To
  98.     @   #   XXXX/YYYY                 Blackout Range  From/To
  99.  
  100.  
  101.           ** = Replace with ONE of the following:
  102.  
  103. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  104. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  105. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  106.                                    (Note:DOOR.SYS must be in SAME directory)
  107. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  108. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  109. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  110. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  111. C:\BBS\GTUSER.BBS               <- For GT Power 
  112.                                    * if using this option you must put the
  113.                                      ComPort # on line 5 and the Node # on
  114.                                      line 6 of the configuration file
  115.  
  116.  
  117.  
  118.            # = Requires registration to change to a different value.
  119.            ! = See "Plays per DAY/DOOR Time" Below
  120.            @ = See "Blackout Periods" Below
  121.  
  122.                NOTE: There are NO Blank Lines in the Config File!!
  123.  
  124.  
  125.  
  126.  
  127.       4) Create a batch file or modify the RESCUE file supplied. A
  128.          description of this file follows:
  129.  
  130.             ECHO off
  131.             cd\PCB\DOORS\RESCUE       Location of RESCUE files
  132.             RESCUE RESCUE.CFG         EXE filename and CFG filename (Name
  133.                               .          kxüR..         kxü.README  1ST ⌡ö«óASREGISTERFRM 4F┐ßD┼ MOREDOORLST I┐UKöNEWSVC      ½F┐ë ORESCUE  HIS ∞Ö╥,ⁿ
  134. RESCUE  DOC CÜ╥RESCUE      uÖ╥(BRESCUE  CFG zÖ╥)·RESCUE  INS yH!║A╡RESCUE15ZIP áàP╗A#CCORDER FRM ºA┐E°RESCUE  EXE ⌐ÿ╥üRµFILE_ID DIZ oÖ╥'1during the Blackout period, they will be shown a message that
  135.       contains ALL the Blackout periods you have defined, and to try the Door
  136.       at a later time.
  137.  
  138.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  139.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  140.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  141.  
  142.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  143.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  144.                    a Blackout range.
  145.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  146.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  147.  
  148.                    
  149.                           PLAYS Per DAY/DOOR Time
  150.                           _______________________
  151.  
  152.       Plays Per Day and Door Time can be controlled several ways:
  153.  
  154.       (1) You can use the Games Per Day, singular option, in the config
  155.           file above. This option, will affect ALL callers whose Security
  156.           Level is NOT defined in any of the 10 optional Security Level/
  157.           Plays Per Day entries in the config file.
  158.  
  159.       (2) You can use the Door Time, singular option, in the config file
  160.           above. This option, will affect ALL callers whose Security
  161.           Level is NOT defined in any of the 10 optional Security Level/
  162.           Plays Per Day/Door Time entries in the config file.
  163.  
  164.       (3) You can restrict the number of games a specific Security Level
  165.           will be allowed to play per day or REWARD specific Levels with 
  166.           more Plays Per Day. 
  167.  
  168.           Likewise, you can restrict the Play time for a specific Security
  169.           Level or REWARD specific Levels with more Door Time.
  170.  
  171.           These options are handled by the use of the 10 config 
  172.           entries (000=00/00). 
  173.           
  174.           The format of each entry is as follows:
  175.  
  176.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  177.                      where =  is a constant and MUST be included
  178.                      where YY is the # of games per day (must be 2 digits)
  179.                      where / is a constant and MUST be included
  180.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  181.           
  182.           If the callers Security Level is NOT defined, his/her Plays Per
  183.           Day and Door Time will be controlled by the values in items
  184.           (1) and (2), above, respectively..
  185.  
  186.           You may define up to 10 Security Levels. All unused entries must
  187.           be defined as   000=00/00
  188.         --------------------------------------------------------------------
  189.           Example: Suppose you had 3 Security Levels defined on your BBS as
  190.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  191.           wanted to set Plays Per Day as :     Subscriber=5
  192.                                            Visiting Sysop=2
  193.                                                   CoSysop=3
  194.                                                    Friend=10 
  195.           
  196.           and Door Time as follows:     Subscriber=30 minutes
  197.                                     Visiting Sysop=20 minutes
  198.                                            CoSysop=10 minutes 
  199.                                             Friend=remaining call time
  200.                                
  201.  
  202.           You would set the Individual "Games per Day" config entry to 1 and 
  203.           the individual "Door Time" to 5 minutes (these would be the 
  204.           default number of games and default Time for all Security Levels
  205.           other than 20,30 or 40... make them any number you want). Next you
  206.           would replace 4 of the Security Level entries as :  020=05/30                                               
  207.                                                               030=02/20
  208.                                                               040=03/10
  209.                                                               090=10/0
  210.  
  211.  
  212.  
  213.  
  214.                         NON-STANDARD COM SUPPORT
  215.                         ________________________
  216.  
  217.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  218.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  219.       number after the configuration filename. Let's assume your Door is
  220.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  221.       passed to your Door would be:
  222.  
  223.                             FOOBAR FOOBAR.CFG /5
  224.  
  225.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  226.       normally used with COM1. No /x parameter is needed for the standard
  227.       IRQ's.
  228.  
  229.       As an alternative, you may use an environmental variable on the command
  230.       line. To use the variable (following the example above), place a 
  231.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  232.       different IRQ number for each node). The command line would now look 
  233.       like this: 
  234.  
  235.                           FOOBAR FOOBAR.CFG /%IRQ%
  236.       
  237.       This, in combination with the use of the environmental variables 
  238.       described in the MULTI-NODE SETUP section will allow you to use one 
  239.       batch file and one config file to run this door on all nodes.
  240.  
  241.  
  242.  
  243.  
  244.                            MULTI-NODE SETUP
  245.                            ________________
  246.  
  247.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  248.       ability to access a configuration file which will have its own system 
  249.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  250.       line. There are 2 ways to accomplish this:
  251.  
  252.       (1) Create a separate configuration file for each node. The only 
  253.           difference between each file would be the location of the system 
  254.           file for that particular node. For example, on my system there are 2
  255.           nodes and the first line of the config files would look like this:
  256.  
  257.                         NODE1:  H:\PCB1\DOOR.SYS
  258.                         NODE2:  H:\PCB2\DOOR.SYS
  259.  
  260.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  261.  
  262.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  263.           the following PCBoard environmental variables:
  264.  
  265.                  PCBDIR    (Directory containing the System file)
  266.                  PCBDRIVE  (Drive containing the System file)
  267.  
  268.           Thus, the first line of the SINGLE configuration file, for this Door
  269.           would look like this:
  270.  
  271.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  272.  
  273.       NOTE: This option, as described, assumes that you are running PCBoard 
  274.             14.5a software. The environmental variables are automatically 
  275.             created by the software for each node.
  276.  
  277.             HOWEVER, if you are running other BBS software you should be able
  278.             to set the variables EXACTLY as described below, for EACH node 
  279.             (more than likely in each batch file you use to bring up EACH node):
  280.  
  281.                             PCBDRIVE=C:
  282.                             ^^^^^^^^^
  283.                             PCBDIR=\NODE2
  284.                             ^^^^^^^^
  285.             
  286.             Info with a carat (^) under it, MUST be typed as is. The rest 
  287.             depends on your naming conventions. 
  288.  
  289.             This, in combination with the use of the optional environmental
  290.             variable described in the NON-STANDARD COM SUPPORT section, will
  291.             allow you to use one batch file and one config file to run this 
  292.             door on all nodes.
  293.  
  294.  
  295.  
  296.  
  297.                                ADOPT-A-DOOR
  298.                                ____________
  299.  
  300.     Having been a Sysop for a number of years, I have had my share of problems
  301.     and frustrations getting financial support for my board's upkeep. A fellow
  302.     Sysop left a message on my board, not long ago, about a concept that was
  303.     being used by several boards around the country.
  304.  
  305.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  306.     would be the same as sending in a donation, only this way it is earmarked
  307.     for registering a particular door. In a way, the user feels he/she is
  308.     "getting something in return". As a Door author I have decided to build
  309.     this concept into each of my Door programs. The concept replaces the
  310.     usual message "tell the Sysop to register this Door" we find in most
  311.     doors.
  312.  
  313.     If the Door is unregisterd then a message appears on the opening screen
  314.     to that effect. After finishing or suspending a game, a message screen
  315.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  316.     caller to contact the Sysop to find out if there is any further details
  317.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  318.     time, etc to callers that ADOPT-A-DOOR.
  319.  
  320.     If the Door has been registered, either by the Sysop or other callers,
  321.     the names of those contributors will be displayed in the closing screen.
  322.  
  323.     NOTE: If you want to display the names of the callers that contributed
  324.           to registering the Door, you must create an ASCII file called
  325.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  326.           the name(s) of the contributors (one on each line, maximum of 5
  327.           entries, each a maximum of 30 characters long). This file must be
  328.           saved, in ASCII format, and placed in the Door directory.
  329.  
  330.  
  331.  
  332.                               LEGALITIES
  333.                               __________
  334.  
  335.  
  336.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  337.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  338.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  339.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  340.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  341.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  342.       OR BREACH OF ANY WARRANTY.
  343.  
  344.  
  345.  
  346.  
  347.  
  348.                              DISTRIBUTION
  349.                              ____________
  350.  
  351.    You may make this file available for downloading from your BBS or you may
  352.    upload it to any BBS of your choice, provided that you do not make any
  353.    changes to the contents of the archive (ZIP file). The archive and its
  354.    individual contents may not be used by any service that charges any money
  355.    whatsoever, without the written permission of the author.
  356.  
  357.  
  358.  
  359.  
  360.  
  361.                              REGISTRATION
  362.                              ____________
  363.  
  364.    Registration and the subsequent insertion of the registration number into
  365.    your configuation file, allows for the display of your BBS name on the
  366.    opening and closing screen as well as the reduction of a delay built into
  367.    the opening screen display along with the ability to change certain
  368.    values in the configuration file.
  369.  
  370.    To register your copy of RESCUE, please fill out the registration form
  371.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  372.    the name and address on the form.
  373.  
  374.    Be sure to use the proper upper/lower case when filling in your name and
  375.    BBS name, as they MUST match the way you entered them in the configuration
  376.    file.             ^^^^
  377.  
  378.    Based upon information supplied on the registration form, I will pre-
  379.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  380.    up your registration number.
  381.  
  382.  
  383.  
  384.                                  MISC
  385.                                  ____
  386.  
  387.    The latest version of RESCUE and other fine SUNRISE DOOR programs are 
  388.    always available for download from SUNRISE-80 BBS.
  389.  
  390.    Remember, should you have any problems, questions or suggestions, be sure
  391.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  392.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDOnet 1:133/410
  393.